<!--

     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.

-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- *  PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- *  i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->

<html>
<head>
    <!-- Generated by groovydoc (2.4.7) on Thu Dec 01 22:36:12 PST 2016 -->
    <title>ScreenRender (Moqui Framework 2.0.0)</title>
    <meta name="date" content="2016-12-01">
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <link href="../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
    <link href="../../../groovy.ico" type="image/x-icon" rel="icon">
    <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
    parent.document.title="ScreenRender (Moqui Framework 2.0.0)";
}
//-->
</script>
<noscript>
    <div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
    <!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../index-all.html">Index</a></li>
        <li><a href="../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../index.html?org/moqui/screen/ScreenRender" target="_top">Frames</a></li>
            <li><a href="ScreenRender.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <a name="skip-navbar_top">
        <!--   -->
    </a></div>
<!-- ========= END OF TOP NAVBAR ========= -->

<!-- ======== START OF CLASS DATA ======== -->
<div class="header">

    <div class="subTitle">Package: <strong>org.moqui.screen</strong></div>

    <h2 title="[Java] Interface ScreenRender" class="title">[Java] Interface ScreenRender</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">

</ul>
<div class="description">
    <ul class="blockList">
        <li class="blockList">


          </li>
    </ul>
</div>

<div class="summary">
    <ul class="blockList">
        <li class="blockList">
        <!-- =========== NESTED CLASS SUMMARY =========== -->
        

        <!-- =========== ENUM CONSTANT SUMMARY =========== -->
        
        <!-- =========== FIELD SUMMARY =========== -->
        

        <!-- =========== PROPERTY SUMMARY =========== -->
        

        <!-- =========== ELEMENT SUMMARY =========== -->
        

        

        
        <!-- ========== METHOD SUMMARY =========== -->
        <ul class="blockList">
            
            <li class="blockList"><a name="method_summary"><!--   --></a>
                    <h3>Methods Summary</h3>
                    <ul class="blockList">
                    <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
                        <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
                        <tr>
                            <th class="colFirst" scope="col">Type</th>
                            <th class="colLast" scope="col">Name and description</th>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#baseLinkUrl(java.lang.String)">baseLinkUrl</a></strong>(java.lang.String baseLinkUrl)</code><br>If specified will be used as the base URL for links. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#encoding(java.lang.String)">encoding</a></strong>(java.lang.String characterEncoding)</code><br>The MIME character encoding for the text produced. </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#macroTemplate(java.lang.String)">macroTemplate</a></strong>(java.lang.String macroTemplateLocation)</code><br>Location of an FTL file with macros used to generate output. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#render(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">render</a></strong>(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)</code><br>Render a screen to a response using the current context. </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code>void</strong></code></td>
                            <td class="colLast"><code><strong><a href="#render(java.io.Writer)">render</a></strong>(java.io.Writer writer)</code><br>Render a screen to a writer using the current context. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code>java.lang.String</strong></code></td>
                            <td class="colLast"><code><strong><a href="#render()">render</a></strong>()</code><br>Render a screen and return the output as a String. </td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#renderMode(java.lang.String)">renderMode</a></strong>(java.lang.String outputType)</code><br>The mode to render for (type of output). </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#rootScreen(java.lang.String)">rootScreen</a></strong>(java.lang.String screenLocation)</code><br>Location of the root XML Screen file to render.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#rootScreenFromHost(java.lang.String)">rootScreenFromHost</a></strong>(java.lang.String host)</code><br>Determine location of the root XML Screen file to render based on a host name.</td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#screenPath(List<String>)">screenPath</a></strong>(java.util.List&lt;java.lang.String&gt; screenNameList)</code><br>A list of screen names used to determine which screens to use when rendering subscreens.</td>
                        </tr>
                        
                        <tr class="altColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#servletContextPath(java.lang.String)">servletContextPath</a></strong>(java.lang.String scp)</code><br>If baseLinkUrl is not specified then this is used along with the webapp-list.webapp configuration to create
 a base URL. </td>
                        </tr>
                        
                        <tr class="rowColor">
                            <td class="colFirst"><code><a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a></strong></code></td>
                            <td class="colLast"><code><strong><a href="#webappName(java.lang.String)">webappName</a></strong>(java.lang.String wan)</code><br>The webapp name to use to look up webapp (webapp-list.webapp.</td>
                        </tr>
                        
                    </table>
                   </ul>
              </li>
            
        </ul>
        
    </li>
    </ul>
</div>

<div class="details">
    <ul class="blockList">
        <li class="blockList">
           

            

            

            

            


            
            <!-- =========== METHOD DETAIL =========== -->
            <ul class="blockList">
                <li class="blockList"><a name="method_detail">
                    <!--   -->
                </a>
                    <h3>Method Detail</h3>
                    
                        <a name="baseLinkUrl(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a> <strong>baseLinkUrl</strong>(java.lang.String baseLinkUrl)</h4>
                                <p> If specified will be used as the base URL for links. If not specified the base URL will come from configuration
 on the webapp-list.webapp element and the servletContextPath.
     <DL><DT><B>Returns:</B></DT><DD>Reference to this ScreenRender for convenience</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="encoding(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a> <strong>encoding</strong>(java.lang.String characterEncoding)</h4>
                                <p> The MIME character encoding for the text produced. Defaults to <code>UTF-8</code>. Must be a valid charset in
 the java.nio.charset.Charset class.
     <DL><DT><B>Returns:</B></DT><DD>Reference to this ScreenRender for convenience</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="macroTemplate(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a> <strong>macroTemplate</strong>(java.lang.String macroTemplateLocation)</h4>
                                <p> Location of an FTL file with macros used to generate output. If not specified macro file from the screen
 configuration will be used depending on the outputType.
     <DL><DT><B>Returns:</B></DT><DD>Reference to this ScreenRender for convenience</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="render(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;void <strong>render</strong>(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)</h4>
                                <p> Render a screen to a response using the current context. The screen will run in a sub-context so the original
 context will not be changed. The request will be used to check web settings such as secure connection, etc.
     </p>
                            </li>
                        </ul>
                    
                        <a name="render(java.io.Writer)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;void <strong>render</strong>(java.io.Writer writer)</h4>
                                <p> Render a screen to a writer using the current context. The screen will run in a sub-context so the original
 context will not be changed.
     </p>
                            </li>
                        </ul>
                    
                        <a name="render()"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;java.lang.String <strong>render</strong>()</h4>
                                <p> Render a screen and return the output as a String. Context semantics are the same as other render methods. </p>
                            </li>
                        </ul>
                    
                        <a name="renderMode(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a> <strong>renderMode</strong>(java.lang.String outputType)</h4>
                                <p> The mode to render for (type of output). Used to select sub-elements of the <code>render-mode</code>
 element and the default macro template (if one is not specified for this render).

 If macroTemplateLocation is not specified is also used to determine the default macro template
 based on configuration.
     <DL><DT><B>Returns:</B></DT><DD>Reference to this ScreenRender for convenience</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>outputType</code> -  Can be anything. Default supported values include: text, html, xsl-fo, xml, and csv.</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="rootScreen(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a> <strong>rootScreen</strong>(java.lang.String screenLocation)</h4>
                                <p> Location of the root XML Screen file to render.
     <DL><DT><B>Returns:</B></DT><DD>Reference to this ScreenRender for convenience</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="rootScreenFromHost(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a> <strong>rootScreenFromHost</strong>(java.lang.String host)</h4>
                                <p> Determine location of the root XML Screen file to render based on a host name.
     <DL><DT><B>Returns:</B></DT><DD>Reference to this ScreenRender for convenience</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>host</code> -  The host name, usually from ServletRequest.getServerName()</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="screenPath(List<String>)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a> <strong>screenPath</strong>(java.util.List&lt;java.lang.String&gt; screenNameList)</h4>
                                <p> A list of screen names used to determine which screens to use when rendering subscreens.
     <DL><DT><B>Returns:</B></DT><DD>Reference to this ScreenRender for convenience</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="servletContextPath(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a> <strong>servletContextPath</strong>(java.lang.String scp)</h4>
                                <p> If baseLinkUrl is not specified then this is used along with the webapp-list.webapp configuration to create
 a base URL. If this is not specified and the active ExecutionContext has a WebFacade active then it will get
 it from that (meaning with a WebFacade this is not necessary to get a correct result).
     <DL><DT><B>Returns:</B></DT><DD>Reference to this ScreenRender for convenience</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>scp</code> -  The servletContext.contextPath</DD></DL></p>
                            </li>
                        </ul>
                    
                        <a name="webappName(java.lang.String)"><!-- --></a>
                        <ul class="blockListLast">
                            <li class="blockList">
                                <h4>public&nbsp;<a href='../../../org/moqui/screen/ScreenRender.html'>ScreenRender</a> <strong>webappName</strong>(java.lang.String wan)</h4>
                                <p> The webapp name to use to look up webapp (webapp-list.webapp.@name) settings for URL building, request actions
 running, etc.
     <DL><DT><B>Returns:</B></DT><DD>Reference to this ScreenRender for convenience</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>wan</code> -  The webapp name</DD></DL></p>
                            </li>
                        </ul>
                    
                </li>
            </ul>
            
        </li>
    </ul>
</div>

<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
    <!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    <!--   -->
</a>
    <ul class="navList" title="Navigation">
        <li><a href="../../../overview-summary.html">Overview</a></li>
        <li><a href="package-summary.html">Package</a></li>
        <li class="navBarCell1Rev">Class</li>
        <li><a href="../../../deprecated-list.html">Deprecated</a></li>
        <li><a href="../../../index-all.html">Index</a></li>
        <li><a href="../../../help-doc.html">Help</a></li>
    </ul>
</div>

<div class="subNav">
    <div>
        <ul class="navList">
            <li><a href="../../../index.html?org/moqui/screen/ScreenRender" target="_top">Frames</a></li>
            <li><a href="ScreenRender.html" target="_top">No Frames</a></li>
        </ul>
    </div>
    <div>
        <ul class="subNavList">
            <li>Summary:&nbsp;</li>
            Nested&nbsp;&nbsp;&nbsp;Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
        <ul class="subNavList">
            <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
            Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
        </ul>
    </div>
    <p>Groovy Documentation</p>
    <a name="skip-navbar_bottom">
        <!--   -->
    </a>
    </div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
